|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.doclinx.ftxml.InputCallback
Extendable callback class that enables an application to control opening
the input source. The application extends this class in order to
implement the callback feature allowing the catAddFile function
to call back to the application for file opening/closing.
The callback class contains the parameter data passed between the API
and the application. The functions in this class are called while processing
the catAddFile()
method.
The default action of the class is to process a single file.
Note that the class object is passed into the API by setting the
sr_f2
object in the SRC2STF_PARMS
parameter block.
Field Summary | |
static int |
ATITLE
parms: array index for alternate document title. |
static int |
ERR_IO
status: error setting -- input stream I/O error. |
static int |
ERR_OPEN
status: error setting -- input stream open error. |
static int |
ERR_PARM
status: error setting -- bad parameter (e.g. parms array bad). |
java.lang.String |
errMsg
errMsg: Error message buffer. |
static int |
FILEKEY
parms: array index for KEY (usually file name). |
static int |
FLAG_SRCFILE
Default callback setting -- process one file. |
protected java.io.InputStream |
isInput
|
static int |
LASTMOD
parms: array index for last mod, date (string rep. of Long value). |
static int |
LENGTH
parms: array index for file length (string rep. of Long value). |
static int |
NOMORE
status: setting if openStream worked OK, but at END of input list. |
static int |
OK
status: setting if openStream worked correctly. |
java.lang.String[] |
parms
parms: String array of entry objects passed between callback and API. |
static int |
SSOURCE
parms: array index of sSource parameter to catAddFile() call. |
int |
status
errMsg: Status code. |
static int |
URL
parms: array index for URL. |
Constructor Summary | |
InputCallback()
Constructor with default value for parameters. |
|
InputCallback(int pFlags)
Constructor with setting type basic file open callback, |
Method Summary | |
boolean |
close()
Callback that may be "extended" to allow application to close the stream and do any cleanup. |
java.io.InputStream |
getStream()
Returns the opened stream object set in the openStream call.
|
boolean |
openStream()
Callback that MUST be "extended" to permit applications to open a file as an InputStream. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int FLAG_SRCFILE
public static final int OK
public static final int NOMORE
public static final int ERR_PARM
public static final int ERR_OPEN
public static final int ERR_IO
public static final int URL
public static final int FILEKEY
public static final int ATITLE
public static final int LENGTH
public static final int LASTMOD
public static final int SSOURCE
protected java.io.InputStream isInput
public java.lang.String[] parms
[0] URL name (optional) [1] Input path or identifier (required) [2] Alternate title (optional) [3] Input length (Long, optional) [4] Last modified time (Long, required for date updates) [5] Copy of sSource parameter in call to catAddFile()
public java.lang.String errMsg
public int status
Constructor Detail |
public InputCallback(int pFlags)
public InputCallback()
Method Detail |
public boolean openStream()
catAddFile
when the mode parameter is ADD_MODE_INPUTCBACK. The default method
uses the sSource parameter as a file name and then opens a stream to this
file. The second call to the open indicates that there are no more streams.
See ADD_MODE_INPUTCBACK
for details.
**none
public boolean close()
**none
public final java.io.InputStream getStream()
openStream
call.
**none
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |